Skip to content

README.md

Latest commit

 

History

History
122 lines (121 loc) · 4.44 KB

README.md

File metadata and controls

122 lines (121 loc) · 4.44 KB
Raw

Compilation

REMEMBER, DO NOT DOWNLOAD FROM "RELEASES" SECTION. GIT CLONE THIS REPO.
To compile: 

git clone https://github.com/norbcodes/entities.git
cd entities/entities2
mkdir build
cd build
cmake ..
make
If you wish to test a dev build, you need to explicitly use --branch parameter when cloning!
You may also specify a custom generator. So if you're a MinGW user: 
git clone https://github.com/norbcodes/entities.git
cd entities/entities2
mkdir build
cd build
cmake .. -G "MinGW Makefiles"
mingw32-make
CMake supports many build systems, read the docs to learn how to adjust it to your build system.
You may also add options, after the .. See options here.
This will produce an executable named entities2.exe (or entities2.out or something similar)
Then, simply run the executable as you would any other: 
./entities2.exe
Or similar.

Precompiled binaries are not provided.

CMake Options

To use these, do so as: -D{option}=ON
Remember, these are COMPILE options. If you want to enable one of these, you must recompile the whole game.

Option Default Info
STATIC_LIBS OFF Statically link against C and C++ standard lib.
Expect an increase in filesize when using this option!
OPTIMIZE OFF Enable optimization. When used, the following
options are passed to the compiler:
-O2 (Optimization level 2)
-g0 (No debug info)
-ggdb0 (No debug info)
-s (Strip symbol table)
ENABLE_DISCORD_RPC OFF Enable Discord RPC. If you want to use it later,
you must recompile with this option present.

If not present, doesn't build the discord-rpc library either.
CUSTOM_DISCORD_ID OFF Custom Discord ID. If set to OFF, the game will use the
original client id. To pass in a custom client id, just pass it into
this option, like -DCUSTOM_DISCORD_ID="42069"
BUILD_DOCS OFF Enable building of Doxygen documentation.
DISABLE_COLORS OFF Disable colors and styling. ALL of it. WARNING: Will make your
game look ugly if enabled :)
4BIT_COLORS OFF Use 4bit colors instead of RGB (ONLY WORKS WHEN COLORS ENABLED)
This will make the game use the predefined terminal colors, that should be more
widely supported than full RGB colors.
4BIT_STYLES OFF Enable styling when in 4Bit color mode (ONLY WORKS WHEN 4BIT COLORS ENABLED)
Yknow, things like bold, italic, underline...
4BIT_AIXTERM OFF Enable bright colors basically (ONLY WORKS WHEN 4BIT COLORS ENABLED)
DISABLE_TERMINAL_BELL OFF Disable terminal bell.
DISABLE_UNSTABLE_WARN OFF Use this if you don't want a warning when you build a dev version of this game.
BUILT_IN_RUSSIAN OFF Embed all of Russian translation into the game. Will increase file size!
BUILT_IN_SLOVAK OFF Embed all of Slovak translation into the game. Will increase file size!
BUILT_IN_TAGALOG OFF Embed all of Tagalog translation into the game. Will increase file size!
BUILT_IN_PORTUGUESE OFF Embed all of Portuguese translation into the game. Will increase file size!
OLD_BEHAVIOR OFF When a translation key doesn't exist, print it out instead of searching in English translations